GETTTYENT

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc
BSD 4.3

NAME

getttyent getttynam setttyent endttyent - get ttys file entry

SYNOPSIS

Fd #include <ttyent.h> Ft struct ttyent * Fn getttyent Ft struct ttyent * Fn getttynam char *name Ft int Fn setttyent void Ft int Fn endttyent void

DESCRIPTION

The Fn getttyent , and Fn getttynam functions each return a pointer to an object, with the following structure, containing the broken-out fields of a line from the tty description file.

struct ttyent {
        char    *ty_name;       /* terminal device name */
        char    *ty_getty;      /* command to execute */
        char    *ty_type;       /* terminal type */
#define TTY_ON          0x01    /* enable logins */
#define TTY_SECURE      0x02    /* allow uid of 0 to login */
#define TTY_LOCAL       0x04    /* set 'CLOCAL' on open (dev. specific) */
#define TTY_RTSCTS      0x08    /* set 'CRTSCTS' on open (dev. specific) */
#define TTY_SOFTCAR     0x10    /* ignore hardware carrier (dev. spec.) */
#define TTY_MDMBUF      0x20    /* set 'MDMBUF' on open (dev. specific) */
        int     ty_status;      /* flag values */
        char    *ty_window;     /* command for window manager */
        char    *ty_comment;    /* comment field */
};

The fields are as follows:

Fa ty_name

The name of the character-special file.

Fa ty_getty

The name of the command invoked by init(8) to initialize tty line characteristics.

Fa ty_type

The name of the default terminal type connected to this tty line.

Fa ty_status

A mask of bit fields which indicate various actions allowed on this tty line. The possible flags are as follows:

TTY_ON: Enables logins (i.e., init(8) will start the command referenced by Fa ty_getty on this entry).
TTY_SECURE: Allow users with a uid of 0 to login on this terminal.
TTY_LOCAL: If the terminal port's driver supports it, cause the line to be treated as ``local.''
TTY_RTSCTS: If the terminal port's driver supports it, use full-duplex RTS/CTS hardware flow control on the line by default.
TTY_SOFTCAR: If the terminal port's driver supports it, ignore hardware carrier on the line.

Fa ty_window

The command to execute for a window system associated with the line.

Fa ty_comment

Any trailing comment field, with any leading hash marks (``#'') or whitespace removed.

If any of the fields pointing to character strings are unspecified, they are returned as null pointers. The field Fa ty_status will be zero if no flag values are specified.

See ttys(5) for a more complete discussion of the meaning and usage of the fields.

The Fn getttyent function reads the next line from the ttys file, opening the file if necessary. The Fn setttyent function rewinds the file if open, or opens the file if it is unopened. The Fn endttyent function closes any open files.

The Fn getttynam function searches from the beginning of the file until a matching Fa name is found (or until EOF is encountered).

RETURN VALUES

The routines Fn getttyent and Fn getttynam return a null pointer on EOF or error. The Fn setttyent function and Fn endttyent return 0 on failure and 1 on success.

FILES

/etc/ttys

HISTORY

The Fn getttyent , Fn getttynam , Fn setttyent , and Fn endttyent functions appeared in BSD 4.3

BUGS

These functions use static data storage; if the data is needed for future use, it should be copied before any subsequent calls overwrite it.

This document was created by man2html, using the manual pages.
Time: 19:41:57 GMT, December 25, 2022